home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1996 #15 / Monster Media Number 15 (Monster Media)(July 1996).ISO / maximus / entr215x.zip / ENTERZ.MAN < prev    next >
Text File  |  1996-06-20  |  6KB  |  143 lines
  1. εNTεRZ                            User's Manual                    εNTεRZ
  2.                        Last revision date: June 20, 1996
  3.  
  4. NAME
  5.     εNTεRZ - displays animated enter prompts
  6.  
  7. SYNOPSIS
  8.     enterz [-f file] [-y num] [-d num] [-n num] [-cvh]
  9.  
  10. DESCRIPTION
  11.     εNTεRZ displays animated enter prompts from a KaF (for more information
  12.     about the KaF, see the User's Manual for the KaFKa utility).  The KaF
  13.     data and index files must have been prepared by KaFKa before εNTεRZ can
  14.     use them.  By default, the program will look for them in it's own home
  15.     directory (and the files are expected to have 'enterz' as the root
  16.     name (with '.kdt' and '.kix' extenions).  It will then display a
  17.     randomly-chosen prompt and wait until the user presses enter, at which
  18.     point it will clear the line and terminate.  The default screen line
  19.     for the prompt is the next line after the text and the prompt will be
  20.     centered on this line (if the definition in the KaF permits it).  This
  21.     operation makes εNTεRZ very suitable for an enter .PEX in the ProBoard
  22.     language prompt. εNTεRZ has been successfully tested with TheMin 2.0 by
  23.     Ruben Provoost [JMJ] (which is a super chat program, by the way, and is
  24.     also free).  It will run will any .PEX that lets you specify an external
  25.     program for the prompts.
  26.  
  27.     You can modify the default behavior by using the command lines.
  28.  
  29.     To install it as the default 'press enter' prompt, copy ENTERZ.PEX,
  30.     ENTERZ.KDT and ENTERZ.KIX to your ProBoard PEX directory.  Fire up
  31.     ProCFG and in the language editor, modify prompt #7 to read:
  32.     '@pENTERZ@' (without the quotes).  Voila!  Instant randomly-selected
  33.     enter prompts.
  34.  
  35.     To make ENTERZ.PEX work with TheMin v2.0, copy the ENTERZ.PEX/KDT/KIX
  36.     to your ProBoard PEX directory.  Then load the file THEMIN.INI into a
  37.     ASCII text editor (the file is in ProBoard's system directory) and
  38.     edit the line 'EnterPEX = ENTER' to read 'EnterPEX = ENTERZ'.  Voila!
  39.     Instant support.
  40.  
  41. OPTIONS
  42.     Every option is preceded by the '-' character, note that the case
  43.     is significant, so make sure you use the correct letters. Options
  44.     can be grouped under one switch except when taking additional
  45.     arguments, in which case the argument must follow the option letter
  46.     (with optional whitespace between them) and should be separated from
  47.     the next option with at least on whitepace character.
  48.  
  49.     -f file
  50.         By default, εNTεRZ will try to use 'enterz.kdt' and 'enterz.kix'
  51.         as the data files.  These are expected to be found in the in the
  52.         program's home directory). To change the default behavior and force
  53.         εNTεRZ to use different names, specify the root name with the '-f'
  54.         option.  Note that you cannot change the extensions of the files.
  55.         An important thing to note is that the '-f' option should precede
  56.         every other option to take effect. Since the command-line is parsed
  57.         sequentially, doing this will ensure correct operation.
  58.  
  59.     -y num
  60.         Changes the screen line.  The 'num' integer must be a valid screen
  61.         y-coordinate (i.e.  0 < num < 25 on most systems).  The default is
  62.         the next line after the last one shown. If necessary, this will also
  63.         scroll the screen by one line so that the last one does not get
  64.         overwritten.
  65.  
  66.     -d num
  67.         Changes the delay interval between the animation steps.  The
  68.         default is the one defined in the KaF.  It is suggested that you do
  69.         not modify this value since most of the prompts that come in the
  70.         default KaF are optimized for this speed.  The greater the value,
  71.         the slower the animation.
  72.  
  73.     -n num
  74.         Select 'num' prompt from the KaF.  The default is randomly
  75.         selected.  Use this if you need to force a particular animation
  76.         somewhere.
  77.  
  78.     -h
  79.         displays a brief summary of correct usage
  80.  
  81.     -v
  82.         displays version information
  83.  
  84.     -c
  85.         displays copyright and license notice
  86.  
  87. EXAMPLES
  88.     enterz
  89.         Select a random sequence and display it on nex line, centered.
  90.  
  91.     enterz -f alt -n34
  92.         Use 'alt.kdt' and 'alt.kix' as the KaF, display prompt 34.
  93.  
  94.     enterz /y12 /n25
  95.         Display prompt #25 on line 12 (note that you can use the slash
  96.         instead of a hyphen to specify an option).
  97.  
  98. FILES
  99.     ENTERZ.PEX  - the main executable for ProBoard v2.1+
  100.     ENTERZ.EXE  - a small command-line utility to check out the KaF
  101.     ENTERZ.KDT  - default data file (95 records)
  102.     ENTERZ.KIX  - index file
  103.  
  104. BUGS
  105.     The language file does not pass parameters correctly. Until Philippe
  106.     fixes this, we are stuck ;-(
  107.  
  108. IDENTIFICATION
  109.     Author: Branislav L. Slantchev
  110.     Revision Number: 2.15
  111.     Release Date: June 20, 1996
  112.     Copyright (c) 1995, 1996 by Branislav L. Slantchev
  113.  
  114. LEGAL
  115.     εNTεRZ was compiled with the following products:
  116.  
  117.         - Borland C++ 3.1, Copyright by Borland Int'l.
  118.  
  119.         - ProBoard SDK v2.10, Copyright (C) by Philippe Leybaert
  120.  
  121.         - PB-Lib v2.15, Copyright (c) by Branislav L. Slantchev
  122.  
  123.     εNTεRZ (all executables, source and documentation files)
  124.     are Copyright (c) 1995, 1996 by Branislav L. Slantchev.
  125.  
  126.     This program is free software; you can redistribute it and/or modify
  127.     it under the terms of the GNU General Public License as published by
  128.     the Free Software Foundation; either version 2 of the License, or
  129.     (at your option) any later version.
  130.  
  131.     This program is distributed in the hope that it will be useful,
  132.     but WITHOUT ANY WARRANTY; without even the implied warranty of
  133.     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  134.     GNU General Public License for more details.
  135.  
  136.     You should have received a copy of the GNU General Public License
  137.     along with this program; if not, write to the Free Software
  138.     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  139.  
  140.     If you find this program useful, drop me a post card at the mail
  141.     address (see file SUPPORT.DOC). I will really appreciate that.
  142.  
  143.